<!-- HTML header for doxygen 1.8.12-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pymoduleconnector: pymoduleconnector.extras.x4_regmap_autogen.XIF Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
  <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    <!-- Platform title -->
    <div class="page-title-bar container-fluid">
      <div id="projectalign" class="row">
        <div id="projectname" class="col-sm-12">pymoduleconnector
          &#160;<span id="projectnumber">1.6.2</span>
        </div>
        <div id="projectbrief" class="col-sm-12">A Python wrapper for XeThru ModuleConnector</div>
      </div>
    </div>
    <div class="topbar">
      <div class="container">
        <div id="titlearea">
          <div class="xethru-logo">
            <img src="xethru-logo_220x55HD.png" alt="Novelda XeThru web site" id="logo-image" />
          </div>
        </div>
        <!-- end header part -->
        <!-- Generated by Doxygen 1.8.12 -->
        <!--BEGIN MAIN-NAV AND SEARCHENGINE-->
        <div id="main-nav"></div>
        <!--END MAIN-NAV AND SEARCHENGINE-->
      </div>
    </div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>pymoduleconnector</b></li><li class="navelem"><b>extras</b></li><li class="navelem"><b>x4_regmap_autogen</b></li><li class="navelem"><a class="el" href="classpymoduleconnector_1_1extras_1_1x4__regmap__autogen_1_1_x_i_f.xhtml">XIF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classpymoduleconnector_1_1extras_1_1x4__regmap__autogen_1_1_x_i_f-members.xhtml">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">pymoduleconnector.extras.x4_regmap_autogen.XIF Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a22f904ab390f7fa8804c4b1371fc37b7"><td class="memItemLeft" align="right" valign="top"><a id="a22f904ab390f7fa8804c4b1371fc37b7"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, block, name)</td></tr>
<tr class="separator:a22f904ab390f7fa8804c4b1371fc37b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5dd168801bee542c1320d0fdc32a6e5"><td class="memItemLeft" align="right" valign="top"><a id="ac5dd168801bee542c1320d0fdc32a6e5"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#ac5dd168801bee542c1320d0fdc32a6e5">__add_reg__</a> (self, reg_class)</td></tr>
<tr class="memdesc:ac5dd168801bee542c1320d0fdc32a6e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add register to local shadow. <br /></td></tr>
<tr class="separator:ac5dd168801bee542c1320d0fdc32a6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfdb69ac38ed2fa3edbcb83e2ce99c0f"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#adfdb69ac38ed2fa3edbcb83e2ce99c0f">set_register</a> (self, address, value)</td></tr>
<tr class="memdesc:adfdb69ac38ed2fa3edbcb83e2ce99c0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a register value in the register map.  <a href="#adfdb69ac38ed2fa3edbcb83e2ce99c0f">More...</a><br /></td></tr>
<tr class="separator:adfdb69ac38ed2fa3edbcb83e2ce99c0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d2f8916948a75fd99a13f1f77c59373"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#a4d2f8916948a75fd99a13f1f77c59373">get_register</a> (self, address)</td></tr>
<tr class="memdesc:a4d2f8916948a75fd99a13f1f77c59373"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a register value from the register map.  <a href="#a4d2f8916948a75fd99a13f1f77c59373">More...</a><br /></td></tr>
<tr class="separator:a4d2f8916948a75fd99a13f1f77c59373"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4902345c70dca7aa488df49b7caf3124"><td class="memItemLeft" align="right" valign="top"><a id="a4902345c70dca7aa488df49b7caf3124"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#a4902345c70dca7aa488df49b7caf3124">__refresh_shadow__</a> (self)</td></tr>
<tr class="memdesc:a4902345c70dca7aa488df49b7caf3124"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh local shadow from chip. <br /></td></tr>
<tr class="separator:a4902345c70dca7aa488df49b7caf3124"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf6841f0d6df7357c46ea508bc30f8be"><td class="memItemLeft" align="right" valign="top"><a id="acf6841f0d6df7357c46ea508bc30f8be"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#acf6841f0d6df7357c46ea508bc30f8be">__iter__</a> (self)</td></tr>
<tr class="memdesc:acf6841f0d6df7357c46ea508bc30f8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable iteration through registers. <br /></td></tr>
<tr class="separator:acf6841f0d6df7357c46ea508bc30f8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1770f1b193008cf9776e372cc183fb1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#aa1770f1b193008cf9776e372cc183fb1">__getitem__</a> (self, seg)</td></tr>
<tr class="memdesc:aa1770f1b193008cf9776e372cc183fb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emulate dict behavior.  <a href="#aa1770f1b193008cf9776e372cc183fb1">More...</a><br /></td></tr>
<tr class="separator:aa1770f1b193008cf9776e372cc183fb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12b0981dfac0714819d0fc2b5ced6554"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpymoduleconnector_1_1extras_1_1regmap_1_1_reg_map.xhtml#a12b0981dfac0714819d0fc2b5ced6554">__setitem__</a> (self, seg, value)</td></tr>
<tr class="memdesc:a12b0981dfac0714819d0fc2b5ced6554"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emulate dict behavior.  <a href="#a12b0981dfac0714819d0fc2b5ced6554">More...</a><br /></td></tr>
<tr class="separator:a12b0981dfac0714819d0fc2b5ced6554"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20be58dab044bf34bf3d4732ef7de561"><td class="memItemLeft" align="right" valign="top"><a id="a20be58dab044bf34bf3d4732ef7de561"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__setattr__</b> (self, name, value)</td></tr>
<tr class="separator:a20be58dab044bf34bf3d4732ef7de561"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ad49a598e1d67f13ea0cfdb4cd4d1ba1b"><td class="memItemLeft" align="right" valign="top"><a id="ad49a598e1d67f13ea0cfdb4cd4d1ba1b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>logger</b></td></tr>
<tr class="separator:ad49a598e1d67f13ea0cfdb4cd4d1ba1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a54bc6696ff33fc9272cee7e631fe1b95"><td class="memItemLeft" align="right" valign="top"><a id="a54bc6696ff33fc9272cee7e631fe1b95"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>debug_xif</b> = property(__get__debug_xif,__set__debug_xif,None,'')</td></tr>
<tr class="separator:a54bc6696ff33fc9272cee7e631fe1b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1fcbc21568cd717670de0f5c1febab4"><td class="memItemLeft" align="right" valign="top"><a id="ac1fcbc21568cd717670de0f5c1febab4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sampler_preset_en</b> = property(__get__sampler_preset_en,__set__sampler_preset_en,None,'')</td></tr>
<tr class="separator:ac1fcbc21568cd717670de0f5c1febab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ee376ded1e7848950c2c40f1643b053"><td class="memItemLeft" align="right" valign="top"><a id="a9ee376ded1e7848950c2c40f1643b053"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sampler_preset_val_msb</b> = property(__get__sampler_preset_val_msb,__set__sampler_preset_val_msb,None,'')</td></tr>
<tr class="separator:a9ee376ded1e7848950c2c40f1643b053"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a893afe529238167535b3deab07e808d0"><td class="memItemLeft" align="right" valign="top"><a id="a893afe529238167535b3deab07e808d0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sampler_preset_val_lsb</b> = property(__get__sampler_preset_val_lsb,__set__sampler_preset_val_lsb,None,'')</td></tr>
<tr class="separator:a893afe529238167535b3deab07e808d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47d6d6b6b11846a4ac914ef00cfa1f8b"><td class="memItemLeft" align="right" valign="top"><a id="a47d6d6b6b11846a4ac914ef00cfa1f8b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>dac_trim_a</b> = property(__get__dac_trim_a,__set__dac_trim_a,None,'')</td></tr>
<tr class="separator:a47d6d6b6b11846a4ac914ef00cfa1f8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a648239a8dc737693f2a10e19adf1e6af"><td class="memItemLeft" align="right" valign="top"><a id="a648239a8dc737693f2a10e19adf1e6af"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>dac_trim_b</b> = property(__get__dac_trim_b,__set__dac_trim_b,None,'')</td></tr>
<tr class="separator:a648239a8dc737693f2a10e19adf1e6af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fab790bdbbe262e1d5ba22955bbc571"><td class="memItemLeft" align="right" valign="top"><a id="a2fab790bdbbe262e1d5ba22955bbc571"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>preamp_trim</b> = property(__get__preamp_trim,__set__preamp_trim,None,'')</td></tr>
<tr class="separator:a2fab790bdbbe262e1d5ba22955bbc571"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63e50c8828b2067b2bc2127549c3e251"><td class="memItemLeft" align="right" valign="top"><a id="a63e50c8828b2067b2bc2127549c3e251"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>rx_fe_anatestreq</b> = property(__get__rx_fe_anatestreq,__set__rx_fe_anatestreq,None,'')</td></tr>
<tr class="separator:a63e50c8828b2067b2bc2127549c3e251"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc8bce2f3f9f5659b2ea33e83e678d03"><td class="memItemLeft" align="right" valign="top"><a id="abc8bce2f3f9f5659b2ea33e83e678d03"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>lna_anatestreq</b> = property(__get__lna_anatestreq,__set__lna_anatestreq,None,'')</td></tr>
<tr class="separator:abc8bce2f3f9f5659b2ea33e83e678d03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d82062816919a6c97d1ec04ac033d82"><td class="memItemLeft" align="right" valign="top"><a id="a9d82062816919a6c97d1ec04ac033d82"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>dac_anatestreq</b> = property(__get__dac_anatestreq,__set__dac_anatestreq,None,'')</td></tr>
<tr class="separator:a9d82062816919a6c97d1ec04ac033d82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a58036d44dd878fca1a7cdb0667f4df"><td class="memItemLeft" align="right" valign="top"><a id="a2a58036d44dd878fca1a7cdb0667f4df"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>vref_trim</b> = property(__get__vref_trim,__set__vref_trim,None,'')</td></tr>
<tr class="separator:a2a58036d44dd878fca1a7cdb0667f4df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad989b123bc558ae9c118caa12ee435f3"><td class="memItemLeft" align="right" valign="top"><a id="ad989b123bc558ae9c118caa12ee435f3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>iref_trim</b> = property(__get__iref_trim,__set__iref_trim,None,'')</td></tr>
<tr class="separator:ad989b123bc558ae9c118caa12ee435f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b814bf91844cb4c15e9f5f8606abddd"><td class="memItemLeft" align="right" valign="top"><a id="a3b814bf91844cb4c15e9f5f8606abddd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>apc_temp_trim</b> = property(__get__apc_temp_trim,__set__apc_temp_trim,None,'')</td></tr>
<tr class="separator:a3b814bf91844cb4c15e9f5f8606abddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa1770f1b193008cf9776e372cc183fb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1770f1b193008cf9776e372cc183fb1">&sect;&nbsp;</a></span>__getitem__()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegMap.__getitem__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>seg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emulate dict behavior. </p>
<p>Gives access to register segments as regmap[segment]. </p>

</div>
</div>
<a id="a12b0981dfac0714819d0fc2b5ced6554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12b0981dfac0714819d0fc2b5ced6554">&sect;&nbsp;</a></span>__setitem__()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegMap.__setitem__ </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>seg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Emulate dict behavior. </p>
<p>Gives access to register segments as regmap[segment]. </p>

</div>
</div>
<a id="a4d2f8916948a75fd99a13f1f77c59373"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d2f8916948a75fd99a13f1f77c59373">&sect;&nbsp;</a></span>get_register()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegMap.get_register </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>address</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get a register value from the register map. </p>
<p>If <b>use_shadow</b> is true, only reads from local shadow buffer. </p>

</div>
</div>
<a id="adfdb69ac38ed2fa3edbcb83e2ce99c0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfdb69ac38ed2fa3edbcb83e2ce99c0f">&sect;&nbsp;</a></span>set_register()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">def pymoduleconnector.extras.regmap.RegMap.set_register </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>self</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set a register value in the register map. </p>
<p>Uses the <b>set_register</b> function to update the chip register. Also updates the local shadow register </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>pymoduleconnector/extras/x4_regmap_autogen.py</li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<hr class="footer"/>
 <address class="footer">
 Copyright &copy; 2016 Novelda AS - <a href="http://www.xethru.com">www.xehtru.com</a><br />
 <small>
  Generated by &#160;<a href="http://www.doxygen.org/index.html">
  <img class="footer" src="doxygen.png" alt="doxygen"/>
  </a> 1.8.12
 </small>
 </address>
</body>
</html>
